home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / lib / forms / RCS / proto.man,v < prev   
Encoding:
Text File  |  1989-01-27  |  4.4 KB  |  172 lines
  1. head     1.5;
  2. branch   ;
  3. access   ;
  4. symbols  ;
  5. locks    ; strict;
  6. comment  @@;
  7.  
  8.  
  9. 1.5
  10. date     89.01.27.08.36.02;  author ouster;  state Exp;
  11. branches ;
  12. next     1.4;
  13.  
  14. 1.4
  15. date     89.01.27.08.34.05;  author ouster;  state Exp;
  16. branches ;
  17. next     1.3;
  18.  
  19. 1.3
  20. date     89.01.09.11.43.01;  author ouster;  state Exp;
  21. branches ;
  22. next     1.2;
  23.  
  24. 1.2
  25. date     89.01.05.17.31.38;  author ouster;  state Exp;
  26. branches ;
  27. next     1.1;
  28.  
  29. 1.1
  30. date     88.12.29.17.09.50;  author ouster;  state Exp;
  31. branches ;
  32. next     ;
  33.  
  34.  
  35. desc
  36. @@
  37.  
  38.  
  39. 1.5
  40. log
  41. @Typo in last change.
  42. @
  43. text
  44. @'\" Copyright 1989 Regents of the University of California
  45. '\" Permission to use, copy, modify, and distribute this
  46. '\" documentation for any purpose and without fee is hereby
  47. '\" granted, provided that this notice appears in all copies.
  48. '\" The University of California makes no representations about
  49. '\" the suitability of this material for any purpose.  It is
  50. '\" provided "as is" without express or implied warranty.
  51. '\" 
  52. '\" $Header: /sprite/lib/forms/RCS/proto.man,v 1.3 89/01/09 11:43:01 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  53. '/" 
  54. .so \*(]ltmac.sprite
  55. .HS <NAME> cmds
  56. .BS
  57. .SH NAME
  58. name \- Short description of what program does
  59. .SH SYNOPSIS
  60. .nf
  61. \fBname\fR [\fIoptions\fR] \fIfile file ...\fR
  62. .SH OPTIONS
  63. .IP "\fB\-x\fR" 14
  64. Sample option so you can see what it looks like.
  65. .IP "\fB\-y \fIname\fR" 14
  66. Another sample option with an argument \fIname\fR.
  67. .SH ARGUMENTS
  68. .AS biggestType biggestName
  69. .AP int argc in
  70. Number of arguments on command line.
  71. .AP char **argv in/out
  72. Command line arguments passed to main program.
  73. .BE
  74.  
  75. .SH DESCRIPTION
  76. .PP
  77. In this section you describe how to use the program.  The description
  78. should be relatively complete, but terse.  For complex programs,
  79. use multiple sections, each describing some aspect of the program.
  80. Here are some notes about how to write manual pages:
  81. .IP [1]
  82. For commands, all the options should be described in the summary box above,
  83. using an \fBOPTIONS\fR section and one \fB.IP\fR for each option.
  84. .IP [2]
  85. For procedures, all of the arguments to the procedure or procedures
  86. should be described in the summary box above, using a \fBARGUMENTS\fR
  87. section and one \fB.AP\fR for each argument.  You shouldn't normally
  88. have both the \fBOPTIONS\fR and \fBARGUMENTS\fR sections in the
  89. same man page.  The \fB.AS\fR macro is used to set tab stops for
  90. the arguments, so they don't run into each other.
  91. .IP [3]
  92. Wherever a term in the manual entry refers to something you
  93. would type verbatim, such as the name of a program or a switch,
  94. use \fBboldface\fR for that term wherever it appears in the manual
  95. entry.
  96. .IP [4]
  97. Wherever a term in the manual entry refers to a meta-symbol, in
  98. place of which the user would type something else, such as \fIfile\fR
  99. in the synopsis above, or the \fIname\fR argument in the \fB-y\fR
  100. option, use \fIitalics\fR for the term wherever it appears in
  101. the manual entry.
  102. .SH KEYWORDS
  103. form, manual
  104. @
  105.  
  106.  
  107. 1.4
  108. log
  109. @Change comment mechanism.
  110. @
  111. text
  112. @d1 9
  113. a9 9
  114. '/" Copyright 1989 Regents of the University of California
  115. '/" Permission to use, copy, modify, and distribute this
  116. '/" documentation for any purpose and without fee is hereby
  117. '/" granted, provided that this notice appears in all copies.
  118. '/" The University of California makes no representations about
  119. '/" the suitability of this material for any purpose.  It is
  120. '/" provided "as is" without express or implied warranty.
  121. '/" 
  122. '/" $Header: /sprite/lib/forms/RCS/proto.man,v 1.3 89/01/09 11:43:01 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  123. @
  124.  
  125.  
  126. 1.3
  127. log
  128. @Made last change in wrong place.
  129. @
  130. text
  131. @d1 10
  132. a10 10
  133. ' Copyright 1989 Regents of the University of California
  134. ' Permission to use, copy, modify, and distribute this
  135. ' documentation for any purpose and without fee is hereby
  136. ' granted, provided that this notice appears in all copies.
  137. ' The University of California makes no representations about
  138. ' the suitability of this material for any purpose.  It is
  139. ' provided "as is" without express or implied warranty.
  140. ' 
  141. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.2 89/01/05 17:31:38 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  142. ' 
  143. @
  144.  
  145.  
  146. 1.2
  147. log
  148. @Trivial cleanups.
  149. @
  150. text
  151. @d9 1
  152. a9 1
  153. ' $Header: /sprite/lib/forms/RCS/proto.man,v 1.1 88/12/29 17:09:50 ouster Exp Locker: ouster $ SPRITE (Berkeley)
  154. d17 1
  155. a19 1
  156. .nf
  157. @
  158.  
  159.  
  160. 1.1
  161. log
  162. @Initial revision
  163. @
  164. text
  165. @d9 1
  166. a9 1
  167. ' $Header: /a/newcmds/prefix/RCS/prefix.man,v 1.1 88/12/22 11:23:28 ouster Exp $ SPRITE (Berkeley)
  168. d19 1
  169. a58 1
  170. .DE
  171. @
  172.